package com.jiandian.crudparams.swaggernotes;

/**
 * 系统日志 controller swagger注释
 *
 * @author lik
 * @date 2018/10/26
 */
public class SysLogNotes {

    public static final String LIST_NOTE = "系统日志列表，入参如下\n" +
            "\n" +
            "```\n" +
            "{\n" +
            "    \"currentPage\": \"当前页\",\n" +
            "    \"pageSize\": \"每页记录条数\",\n" +
            "    \"orderColumn\": \"排序列(非必填)\",\n" +
            "    \"orderSort\": \"排序方法[asc:正序，desc:倒序],默认倒序\",\n" +
            "    \"whereMap\": {\n" +
            "        \"name\": \"名称\"\n" +
            "    }\n" +
            "}\n" +
            "```";


    public static final String LIST_VALUE = "\n" +
            "\n" +
            "```\n" +
            "{\n" +
            "    \"currentPage\": 1,\n" +
            "    \"pageSize\": 10,\n" +
            "    \"whereMap\": {\n" +
            "        \"name\": \"名称\"\n" +
            "    }\n" +
            "}\n" +
            "```";

    public static final String ADD_NOTE = "系统日志，入参如下\n" +
            "\n" +
            "```\n" +
            "{\n" +
            "    \"userId\": \"用户id\",\n" +
            "    \"username\": \"用户名\",\n" +
            "    \"operation\": \"用户操作描述\",\n" +
            "    \"time\": \"响应时间\",\n" +
            "    \"method\": \"请求方法\",\n" +
            "    \"params\": \"请求参数\",\n" +
            "    \"ip\": \"IP地址\",\n" +
            "    \"gmtCreate\": \"创建时间\",\n" +
            "    \"gmtModified\": \"更新时间\"\n" +
            "}\n" +
            "```";

    public static final String ADD_VALUE = "\n" +
            "\n" +
            "```\n" +
            "{\n" +
            "    \"userId\": \"用户id\",\n" +
            "    \"username\": \"用户名\",\n" +
            "    \"operation\": \"用户操作描述\",\n" +
            "    \"time\": \"响应时间\",\n" +
            "    \"method\": \"请求方法\",\n" +
            "    \"params\": \"请求参数\",\n" +
            "    \"ip\": \"IP地址\",\n" +
            "    \"gmtCreate\": \"创建时间\",\n" +
            "    \"gmtModified\": \"更新时间\"\n" +
            "}\n" +
            "```";

    public static final String EDIT_NOTE = "系统日志修改，入参如下\n" +
            "\n" +
            "```\n" +
            "{\n" +
            "    \"id\": \"日志id\",\n" +
            "    \"userId\": \"用户id\",\n" +
            "    \"username\": \"用户名\",\n" +
            "    \"operation\": \"用户操作描述\",\n" +
            "    \"time\": \"响应时间\",\n" +
            "    \"method\": \"请求方法\",\n" +
            "    \"params\": \"请求参数\",\n" +
            "    \"ip\": \"IP地址\",\n" +
            "    \"gmtCreate\": \"创建时间\",\n" +
            "    \"gmtModified\": \"更新时间\"\n" +
            "}\n" +
            "```";

    public static final String EDIT_VALUE = "\n" +
            "\n" +
            "```\n" +
            "{\n" +
            "    \"id\": \"日志id\",\n" +
            "    \"userId\": \"用户id\",\n" +
            "    \"username\": \"用户名\",\n" +
            "    \"operation\": \"用户操作描述\",\n" +
            "    \"time\": \"响应时间\",\n" +
            "    \"method\": \"请求方法\",\n" +
            "    \"params\": \"请求参数\",\n" +
            "    \"ip\": \"IP地址\",\n" +
            "    \"gmtCreate\": \"创建时间\",\n" +
            "    \"gmtModified\": \"更新时间\"\n" +
            "}\n" +
            "```";

}
